home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / tag_bbs / tag_sh32.zip / TAG_SHUT.DOC < prev    next >
Text File  |  1992-04-13  |  19KB  |  461 lines

  1.  
  2.     Are you tired of those annoying one time callers who log on to your BBS
  3. only once, and never return again, leaving you with a wasted user record?
  4.  
  5.  
  6.     Are you a sysop who is looking for a way to screen users before allowing
  7. them to have an account on your bbs? 
  8.  
  9.  
  10.     Are you looking for an extra little edge against the Big Hack-Attack that
  11. worries so many sysops running "open" TAG systems?
  12.  
  13.  
  14.     Are you a sysop who caters to the non-public domain LEECH and need a way
  15. to add more pinache to your system (recent upload bulletins etc.) that the 
  16. general public can't see?
  17.  
  18.  
  19.  
  20.                        WELL THEN READ ON, BECAUSE.......
  21.  
  22.  
  23.  
  24.  TTTTTTTT  AAAAAAA   GGGGGGG             SSSSSSSS  HH   HH   UU    UU  TTTTTTTT
  25.     TT     AA   AA   GG   GG             SS    SS  HH   HH   UU    UU     TT
  26.     TT     AA   AA   GG                  SS        HH   HH   UU    UU     TT 
  27.     TT     AAAAAAA   GG  GGG             SSSSSSSS  HHHHHHH   UU    UU     TT
  28.     TT     AA   AA   GG   GG                   SS  HH   HH   UU    UU     TT  
  29.     TT     AA   AA   GG   GG             SS    SS  HH   HH   UU    UU     TT
  30.     TT     AA   AA   GGGGGGG  =========  SSSSSSSS  HH   HH   UUUUUUUU     TT
  31.  
  32.  
  33.                     *_THE_*  Shuttle Log-on door for T.A.G.
  34.                          
  35.                                    has arrived
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.                                    TAG_SHUT
  43.                                  ------------
  44.                        A Shuttle Log-On Door for TAG BBS's
  45.  
  46.  
  47. A brief comment from the author (me):
  48.  
  49. I wrote this door to fill a gap for converted Telegard SysOps (yup, I was one
  50. of them once too!). There seemed to be a lot of sysops around who had convert-
  51. ed from Telegard to TAG and one of the features they found to be lacking was 
  52. a so-called "Shuttle" menu. Personally, I found them to be quite annoying,
  53. but, since there was a need, I took it upon myself to fill the gap.
  54.  
  55. You know what? Since I have been running it, I have come to like it!! It does
  56. a great job of looking after all of those annoying call one time type of bbs
  57. users who just love to eat up user list space.
  58.  
  59. I may or may not continue to work on this door, depending on the reception it
  60. gets in the TAG community. The program is provided as-is, without charge for 
  61. those who choose to run it. Registration in most cases, is *_NOT_* required.
  62. But it is an option that is available to those who wish to do so. The door will
  63. function just fine as-is. BUT, ! Registration does have it's advantages! 
  64.  
  65. PLEASE READ THE ENCLOSED TAG_SHUT.REG FILE !!
  66.  
  67. The person who sends me the *_BEST_* questionnaire file, that best shows off
  68. the abilities (such as they are) of the questionnaire system, will have their
  69. questionnaire file included in the distribution files and honourable mention of
  70. their efforts given in the credits section of the docs. Not too mention, that I
  71. will be forever grateful and willing to allow said person to test any upcoming
  72. releases (boy, now there's a bonus!).
  73.  
  74. The docs for the program are broken down into the following areas:
  75.  
  76. 2) Start up
  77. 3) SHUTTLE.CFG file, options
  78. 4) Questionnaire file, options
  79. 5) Undocumented features.
  80. 6) Credit where credit is due.
  81.  
  82. Special note : R.T.F.D. (Read The Faruking Docs!!) 
  83. Translation  : Read, what you are doing now
  84.                Faruk, being the handle I use on my bbs
  85.                Docs, the file that quite often accompanies a program and tries
  86.                to explain the operation and set-up of the program which so many
  87.                sysops tend to try and avoid reading.
  88.  
  89.       *-----------------------------------------------------------------*
  90.  
  91. Start-up : 
  92.  
  93. 1) Put the files, Shuttle.EXE, Shuttle.CFG, Newuser.APP (if used) and
  94.    MakeMsg.EXE in some directory you wish to run TAG_SHUT from. On my system
  95.    I have a directory off of my base BBS directory called shuttle and it runs
  96.    from there.
  97.  
  98. 2) Create a (or edit the enclosed) file called WELCOME.BAT in your main bbs
  99.    directory. This file needs to copy the file DORINFO1.DEF into the dir that
  100.    SHUTTLE.EXE is located in, switch to that directory and run SHUTTLE.EXE
  101.  
  102. Example:   (for a standard TAG 2.6 system)
  103.  
  104. @ECHO OFF
  105. COPY DORINFO1.DEF SHUTTLE   (puts dorinfo1.def in shuttle dir)
  106. CD SHUTTLE                  (go to shuttle dir)
  107. SHUTTLE                     (runs shuttle)
  108. DEL DORINFO1.DEF            (deletes dorinfo1.def after use (yes, it should!))
  109. CD ..                       (changes back to the main BBS dir)
  110. EXIT                        (back to the bbs)
  111.  
  112. Example:   (for a TAG 2.6a+ beta system or the upcoming multi-user system)
  113.  
  114. @ECHO OFF
  115. COPY DORINFO#.DEF SHUTTLE\DORINFO1.DEF   (puts dorinfo1.def in shuttle dir)
  116. CD SHUTTLE                               (go to shuttle dir)
  117. SHUTTLE                                  (runs shuttle)
  118. DEL DORINFO1.DEF            (deletes dorinfo1.def after use (yes, it should!))
  119. CD ..                       (changes back to the main BBS dir)
  120. EXIT                        (back to the bbs)
  121.  
  122. Note: DORINFO#.DEF is created for 2.6a single-user system such as mine. TAG
  123.       should create DORINFO#.DEF according to your system if running multiple
  124.       nodes, and WELCOME.BAT should be edited accordingly. At the moment, my
  125.       door ONLY supports dorinfo1.def, and may change soon if a need is seen.
  126.  
  127.       *-----------------------------------------------------------------*
  128.  
  129.                       SETTING UP THE SHUTTLE.CFG FILE      
  130.  
  131. Shuttle.cfg file contents:
  132.  
  133. enter_system             <------ Password to enter system
  134. yes                      <------ option to force shuttle locally  
  135. yes                      <------ was for, uhm, uhh, oh ya! 
  136. 15                       <------ Maximum time in door 
  137. 5                        <------ Maximum inactivity time (kills sleepers!)
  138. c:\bbs\dfiles            <------ Path to your USER.LST (NO TRAILING SLASH!!)
  139. Faruk You                <------ Who to send request for access msg to
  140. c:\bbs\email             <------ Where to put request for access msg.
  141. New User Application     <------ Title of request for access msg.
  142. new_user_read_mail       <------ Password to read reply msg. from sysop
  143.                                  or whomever msg. request for access message
  144.                                  was sent to.
  145.  
  146. Password to enter system: 
  147.                           No other checking is done on a user for validity. It
  148. is not necessary for a user to have a valid account, as TAG will trap the user
  149. with it's new user log-on.
  150.  
  151. Option to force local:
  152.                        Simple YES or no here will dictate whether or not the
  153. shuttle will check a user for local log on.  I may do some work on this in the
  154. near future and fix a couple small holes in the local log on. As it is now, all
  155. you need do is either enter the password or hit (G) to hang up and you are in
  156. the bbs. (Actually you are already, and TAG has no way to know whether or not
  157. you should be. I may reboot the entire system at this point eventually). 
  158.                      
  159. Uhm, er, uhh : 
  160.                Will be an option to specify whether or not a user may (F)ind
  161. out the system password. (Yet more security? sheesh....)
  162.  
  163. Max time in door: 
  164.                   T.A.G. 2.6 (standard, upgrade, whatever) writes DORINFO1.DEF
  165. with a max time of 500 minutes in the door. Definitely not desirable!
  166.  
  167. Max idle time:
  168.                Specifies max time a user may sit and stare at a prompt without
  169. showing some sort of life form.
  170.  
  171. Path to USER.LST:
  172.                   Gee. Wonder what that would be?  (must be fully qualified
  173. path to TAG's USER.LST file less trailing backslash.
  174.  
  175. User name to post "Request for access" msg to:
  176.                                                This is the name of the user to
  177. post the new user to (contents of questionnaire). May be SysOp (TAG knows who
  178. you are), or your handle/name or anyone else (valid of course) on the system.
  179.  
  180. Path to post message:
  181.                       This should be the path to your Area 0 private EMAIL
  182. directory. Can be any fido compatible *.MSG directory, (NET or ECHO also) but 
  183. EMAIL is best.
  184.  
  185. Title to place on new user message:
  186.                                     Pretty much self explanatory. All new user
  187. requests will have this title on them.
  188.  
  189. New user read mail password:
  190.                             This is the password the new user MUST enter in
  191. order to be able to read the reply left to them regarding their request for
  192. access. ONLY NON-USERS have access to this command to prevent theft of mail 
  193. that belongs to valid system members. THIS WILL NEVER CHANGE, SO DON'T ASK!!
  194.  
  195. There really is no special info needed for the format of the .cfg file. Just
  196. take and edit the enclosed file to suit your needs and you are all set here.
  197.  
  198.       *-----------------------------------------------------------------*
  199.  
  200.                         SETTING UP THE NEWUSER.APP FILE       
  201.  
  202. Example file:
  203.  
  204. #What's your real name ? @Q@
  205. #What's your reason for wishing access to this bbs? >@Q@
  206.  
  207. cmd color 0 6 0
  208. #Are you a sysop of a bbs? @O@
  209. #Is your hair brown? @O@
  210. cmd color 0 3 0
  211. cmd cls
  212. ...     display a screen of system info   ...
  213. .
  214. .
  215. This is the end of the displayed page, press any key to go on@P@
  216. cmd color 0 4 0
  217. Thanks for your time. Please call back in a day or two to check
  218. and see if you have a reply to your application.
  219.  
  220.  
  221.     *------------------------------------------------------------------*
  222.  
  223. Valid commands for use in the newuser.app questionnaire file
  224.  
  225. @Q@
  226. @O@
  227. @$@
  228. >
  229.  
  230. #
  231.  
  232. @P@
  233.  
  234. cmd cls
  235. cmd color 0 5 0
  236.  
  237. Explanation of commands:
  238.  
  239. @Q@ - specifies a MANADATORY question. User must supply at least 1 character
  240.       of input to answer and go on. (don't ask!)
  241.  
  242. @O@ - specifies an OPTIONAL question to ask of the user. Just hitting C/R will
  243.       go on past the question and output a blank line to the answer message.
  244.  
  245. @$@ - specifies input of a phone number from the user (North American format).
  246.  
  247.  >  - placed in front of either of the @Q@ or @O@ prompts will force a line-
  248.       feed and carriage return before prompting for an answer to the output
  249.       line.
  250.  
  251. #   - Forces line to be included in the answer message.
  252.  
  253. @P@ - force a pause at current line. Produces a [Paused] prompt.
  254.  
  255. cmd cls - clears both local and remote screens when processed.
  256.  
  257. cmd color - changes colors. 
  258.             command syntax : cmd color x y z
  259.                              x being background color
  260.                              y being foreground color
  261.                              z being blinking if 1 and no blink if 0
  262.  
  263. Valid Background Colours :
  264.  
  265.             0  : black                  4  : red
  266.             1  : blue                   5  : magenta
  267.             2  : green                  6  : brown
  268.             3  : cyan                   7  : light gray
  269.  
  270. Valid Foreground Colours :
  271.  
  272.    0  : black    4  : red           8  : dark gray     12  : light red
  273.    1  : blue     5  : magenta       9  : light blue    13  : light magenta
  274.    2  : green    6  : brown        10  : light green   14  : yellow
  275.    3  : cyan     7  : light gray   11  : light cyan    15  : white
  276.  
  277.  
  278.  
  279. See that blank line right up here ^^^^^^^^^^^^^ ?  
  280.  
  281. Yup, you guessed it, a blank line is just that, a blank line and is displayed 
  282. that way. Text lines may also be added wherever you so choose.
  283.  
  284.  
  285.      *----------------------------------------------------------------- *
  286.  
  287. Other important stuff:
  288.  
  289. 1)        The F10 key will initiate a chat mode at ANY time. Split screen
  290.           mode or single line (you type first, user types next) will be
  291.           chosen depending on whether or not the user has ansi.
  292.  
  293. 2)        The F1 key when pressed in chat will drop the user back to the
  294.           point at which they left off.
  295.  
  296. 3)        The F9 key when pressed, hits the user with fake line noise.
  297.  
  298. 4)        The F8 key when pressed, hits the user with fake line noise and
  299.           then disconnects the call.
  300.  
  301. 5)        The chat page is enabled/disabled via the scroll lock key.
  302.           Scroll on / chat page bell on. Scroll off / chat page bell off.
  303.  
  304. 6)        The screen is restored in mono after a sysop initiated chat,
  305.           sorry, but at the moment it's the best I can do (which by the
  306.           way is a far cry better than most chat utilities do).
  307.           
  308. 7)        If found, either MENU.CLR or MENU.MSG will be displayed in place
  309.           of the built in main menu. File(s) must be in same directory that
  310.           SHUTTLE.EXE was run from
  311.  
  312. 8)        If found, either WELCOME.CLR or WELCOME.MSG will be displayed in
  313.           place of the built in welcome message. File(s) must be in same
  314.           directory that SHUTTLE.EXE was run from.
  315.  
  316.           HINT: remove welcome.msg and clr from TAG's directory (A or G FILES)
  317.                 and replace them with an empty file of the same name. This will
  318.                 allow TAG to detect ansi and funtion without errors while not
  319.                 forcing users to spend all of their online time looking at ANSI
  320.                 screens. Makes for a nice seamless interface.
  321.  
  322. 9)        This program is 99.99% safe for use in a multi-user system. It 
  323.           only reads from the user.lst file and TAG "may" try and write
  324.           to it while TAG_SHUT has it open. TAG_SHUT only keeps the file
  325.           open for a very brief time in read-only mode, so that should
  326.           not be a problem under most circumstances. If anyone finds that
  327.           their user.lst file gets blown away while using this door in
  328.           a multi-user system, PLEASE NOTIFY ME !!
  329.                     
  330. 10)       Questionnaire lines are limited and truncated to 78 characters.
  331.  
  332.      *----------------------------------------------------------------- *
  333.  
  334.                            UNDOCUMENTED FEATURES
  335.  
  336. In keeping with the true tradition of TAG, bugs are non existant unless they
  337. are proven to be FTSC compatible ANNOYING and/or OFFENSIVE. Otherwise, they
  338. are to be considered only as undocumented features, all of which I would very
  339. much like to hear of so that I may include them in the docs. :-)
  340.  
  341. Further to this portion of the documentation, all undocumented features will
  342. see inclusion to the system/docs in approximately a WWeek, which for those who
  343. may be as yet uninitiated, is roughly three weeks from the Tuesday after my
  344. Mothers 92nd birthday (anytime sooner is a bonus for you!).
  345.  
  346.  
  347.      *----------------------------------------------------------------- *
  348.  
  349.  
  350. Credit where due:
  351.  
  352. First of all, I must give credit to my girlfriend Brita without who's 
  353. patience and understanding this door would not exist, much less that my
  354. BBS and TAG Alpha support for Canada would likely not exist either.
  355.  
  356. Thanks Sweetheart, and please continue to be as patient as you have.
  357.  
  358. Secondly, my children, Teddy and Hillary. You guys have sacrificed a lot of
  359. my time in order that I can develop this package and I promise that come 
  360. summer, we'll see lots of the good times again.
  361.  
  362. I love you two guys!
  363.  
  364. NEXTLY:  
  365.                                      THE
  366.  
  367.       /\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
  368.      /\/\/\/                                                          \/\/\/\
  369.     |   /\/    ______________        ______          ___________       \/\   |
  370.     |  / /    /             /|      /     /|        /          /\       \ \  |
  371.     | / /     TTTTTTTTTTTTTT/       AAAAAA /|       GGGGGGGGGGG\/|       \ \ |
  372.     |/\/ /\         TT |           AA|___AA /|      GG |      GG/      /\ \/\|
  373.     |-< <  >        TT |          AA/     AA /|     GG |   _____      <  > >-|
  374.     |\/\ \/         TT |         AAAAAAAAAAAA |     GG |  /     /|     \/ /\/|
  375.     | \ \           TT |         AA |      AA |     GG |__GGGGGG |       / / |
  376.     |  \ \          TT |         AA |      AA |     GG/       GG |      / /  |
  377.     |   \/\         TT/   <>     AA/       AA/  <>   GGGGGGGGGGG/  <>  /\/   |
  378.      \/\/\/\                                                          /\/\/\/
  379.       \/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/
  380.  
  381.                                      TEAM
  382.  
  383. Thanks guys, (Vic, Randy and Paul especially), if it were not for you guys
  384. and your generosity none of us would have this fine BBS package to run.
  385.  
  386.  
  387. And finally:          
  388.                                 Rod Bowman
  389.                                    and
  390.  
  391.              ┌──────────────────────────────────────────────┐
  392.              │             MOTOR CITY SOFTWARE              │
  393.              │   ┌──────────────────────────────────────┐   │
  394.              │   │       JPDoor - Version 3.1 SE        │   │
  395.              │   │            ┌──────────┐              │   │
  396.              │   │            │\         │              │   │
  397.              │   │            │ \        │              │   │
  398.              │   │            │  \   P   │              │   │
  399.              │   │            │   \  A   │              │   │
  400.              │   │            │   │  S   │              │   │
  401.              │   │            │   │  C   │              │   │
  402.              │   │     5.5    │   │  A   │    6.0       │   │
  403.              │   │            │  o│  L   │              │   │
  404.              │   │            │   │      │              │   │
  405.              │   │            \   │──────┘              │   │
  406.              │   │             \  │                     │   │
  407.              │   └──────────────\ │─────────────────────┘   │
  408.              │      The Ultimate \│ Door Writing Unit.      │
  409.              └────────────────────┴─────────────────────────┘
  410.  
  411.              Don't be fooled! It's a dandy of a door interface.
  412.  
  413.  
  414. Also, those who tested TAG_SHUT, Kevin Sawyer, Mike Thurlow (TAG ßeta site) and
  415. Gary Green (TAG ßeta site).
  416.  
  417.  
  418. Planned enhancements :
  419.  
  420. 1) Inclusion of defineable sysop page call.
  421.  
  422. 2) Capture of chat sessions
  423.  
  424. 3) Finishing touches to error logging and exit codes for future support of
  425.    TAG (maybe). At present all local logons (in error or not) will allow a 
  426.    successful entry to TAG which may not be desirable under certain circum-
  427.    stances.
  428.  
  429. 4) Defineable chat times.
  430.  
  431. 5) Call back verification (should prove interesting).
  432.  
  433. 6) Rebooting of computer on failed local logon.
  434.  
  435. 7) addition of some questionnaire goodies such as formatted phone number entry.
  436.  
  437. 8) Sysop definition of menu commands.
  438.  
  439. 9) Complete rewrite of code to eliminate use of JPDoor and reduce memory usage
  440.    dramatically. Current version (2.1) uses about 130k. 
  441.  
  442.  
  443. Enjoy the door!
  444.  
  445. Drew Smith  (aka  Faruk You)
  446.  
  447.  
  448. Support : 
  449.  
  450. Currently, only I support the program but that may change.
  451.  
  452. I can be reached via, TAG_DOORS, TAG, and TAG_BETA echos and via any of the 
  453. other TAG αlpha sites, or directly at:
  454.  
  455. (416) 549-2473 (The MutherBoard BBS, TAG αlpha site for Canada)
  456.  
  457. Via FIDONET 1:244/126, RBBSNET 8:990/300 - 301, TAGNET 26:1/111
  458.  
  459. Modem speed currently 14.4k but soon to be 9600 v.32
  460.  
  461.